# Правила Контрибьютинга

## 1. Коммиты пишем на Английском, Документацию на русском

**`Почему?`**

1. Документацию читают все, а коммиты только мы.
2. Английский позволяет лучше выразить терминологию

## 2. Используем семантические коммиты

**`Спецификация`**: https://www.conventionalcommits.org/en/v1.0.0/

Правило не строгое. Мелкие изменения можно отправлять одним коммитом.

В сообщениях коммитов можно использовать Emoji ✨

## 3. Гайд по развёртке проекта локально

### Установка

1. Клонируем репозиторий
   ```bash
   git clone https://github.com/AlexXanderGrib/node-qiwi-sdk.git
   ```
2. Заходим в папку
   ```bash
   cd node-qiwi-sdk
   ```
3. Устанавливаем зависимости
   ```bash
   npm install
   ```

### Тестирования

**🇬🇧: `Testing`**

1. Вписываем это в файл `.env`:

   ```bash
   QIWI_TOKEN=<TOKEN>
   QIWI_WALLET=<PHONE>
   QIWI_SECRET_KEY=<KEY>
   QIWI_PUBLIC_KEY=<PUB_KEY>
   ```

2. Меняем:
   1. `<TOKEN>` на ваш токен киви, полученный на [официальном сайте](https://qiwi.com/api) (должен быть со всеми правами)
   2. `<PHONE>` на номер телефона, на который зарегистрирован кошелёк (в формате `79123456789`)
   3. `<KEY>` на секретный ключ, полученный на сайте [QIWI P2P API](https://qiwi.com/p2p-admin/transfers/api)
   4. `<PUB_KEY>` на публичный ключ
3. Запускаем

   ```bash
   npm test
   ```
